PageDomain

class PageDomain : Domain

Actions and events related to the inspected page belong to the page domain.

Functions

addCompilationCache

fun addCompilationCache(input: AddCompilationCacheRequest): Single<RequestResponseFrame>

Seeds compilation cache for given url.

addScriptToEvaluateOnLoad

fun addScriptToEvaluateOnLoad(input: AddScriptToEvaluateOnLoadRequest): Single<AddScriptToEvaluateOnLoadResponse>

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

addScriptToEvaluateOnNewDocument

fun addScriptToEvaluateOnNewDocument(input: AddScriptToEvaluateOnNewDocumentRequest): Single<AddScriptToEvaluateOnNewDocumentResponse>

Evaluates given script in every frame upon creation (before loading frame's scripts).

bringToFront

fun bringToFront(): Single<RequestResponseFrame>

Brings page to front (activates tab).

captureScreenshot

fun captureScreenshot(input: CaptureScreenshotRequest): Single<CaptureScreenshotResponse>

Capture page screenshot.

captureSnapshot

fun captureSnapshot(input: CaptureSnapshotRequest): Single<CaptureSnapshotResponse>

Returns a snapshot of the page as a string.

clearCompilationCache

fun clearCompilationCache(): Single<RequestResponseFrame>

Clears seeded compilation cache.

clearDeviceMetricsOverride

fun clearDeviceMetricsOverride(): Single<RequestResponseFrame>

Clears the overriden device metrics.

clearDeviceOrientationOverride

fun clearDeviceOrientationOverride(): Single<RequestResponseFrame>

Clears the overridden Device Orientation.

clearGeolocationOverride

fun clearGeolocationOverride(): Single<RequestResponseFrame>

Clears the overriden Geolocation Position and Error.

close

fun close(): Single<RequestResponseFrame>

Tries to close page, running its beforeunload hooks, if any.

compilationCacheProduced

fun compilationCacheProduced(): Flowable<CompilationCacheProducedEvent>

Issued for every compilation cache generated.

crash

fun crash(): Single<RequestResponseFrame>

Crashes renderer on the IO thread, generates minidumps.

createIsolatedWorld

fun createIsolatedWorld(input: CreateIsolatedWorldRequest): Single<CreateIsolatedWorldResponse>

Creates an isolated world for the given frame.

deleteCookie

fun deleteCookie(input: DeleteCookieRequest): Single<RequestResponseFrame>

Deletes browser cookie with given name, domain and path.

description

fun description(): String

Returns domain description.

disable

fun disable(): Single<RequestResponseFrame>

Disables page domain notifications.

documentOpened

fun documentOpened(): Flowable<DocumentOpenedEvent>

Fired when opening document to write to.

domContentEventFired

fun domContentEventFired(): Flowable<DomContentEventFiredEvent>

Returns observable capturing all Page.domContentEventFired events.

downloadProgress

fun downloadProgress(): Flowable<DownloadProgressEvent>

Fired when download makes progress.

downloadWillBegin

fun downloadWillBegin(): Flowable<DownloadWillBeginEvent>

Fired when page is about to start a download.

enable

fun enable(): Single<RequestResponseFrame>

Enables page domain notifications.

events

fun events(): Flowable<Event>

Returns flowable capturing all domains events.

fun events(filter: Predicate<Event>): Flowable<Event>

Returns flowable capturing all domains events matching predicate.

fun <T : Event> events(eventClass: Class<T>): Flowable<T>

Returns flowable capturing all domain events of a given type.

fun <T : Event> events(eventClass: Class<T>, filter: Predicate<T>): Flowable<T>

Returns flowable capturing all domain events of a given type matching predicate.

fileChooserOpened

fun fileChooserOpened(): Flowable<FileChooserOpenedEvent>

Emitted only when page.interceptFileChooser is enabled.

frameAttached

fun frameAttached(): Flowable<FrameAttachedEvent>

Fired when frame has been attached to its parent.

frameClearedScheduledNavigation

fun frameClearedScheduledNavigation(): Flowable<FrameClearedScheduledNavigationEvent>

Fired when frame no longer has a scheduled navigation.

frameDetached

fun frameDetached(): Flowable<FrameDetachedEvent>

Fired when frame has been detached from its parent.

frameNavigated

fun frameNavigated(): Flowable<FrameNavigatedEvent>

Fired once navigation of the frame has completed.

frameRequestedNavigation

fun frameRequestedNavigation(): Flowable<FrameRequestedNavigationEvent>

Fired when a renderer-initiated navigation is requested.

frameResized

fun frameResized(): Flowable<RawEvent>

Returns observable capturing all Page.frameResized events.

frameScheduledNavigation

fun frameScheduledNavigation(): Flowable<FrameScheduledNavigationEvent>

Fired when frame schedules a potential navigation.

frameStartedLoading

fun frameStartedLoading(): Flowable<FrameStartedLoadingEvent>

Fired when frame has started loading.

frameStoppedLoading

fun frameStoppedLoading(): Flowable<FrameStoppedLoadingEvent>

Fired when frame has stopped loading.

generateTestReport

fun generateTestReport(input: GenerateTestReportRequest): Single<RequestResponseFrame>

Generates a report for testing.

getAppManifest

fun getAppManifest(): Single<GetAppManifestResponse>

getCookies

fun getCookies(): Single<GetCookiesResponse>

Returns all browser cookies.

getDependencies

open override fun getDependencies(): List<Domain>

Returns list of dependant domains that should be enabled prior to enabling this domain.

getFrameTree

fun getFrameTree(): Single<GetFrameTreeResponse>

Returns present frame tree structure.

getInstallabilityErrors

fun getInstallabilityErrors(): Single<GetInstallabilityErrorsResponse>

getLayoutMetrics

fun getLayoutMetrics(): Single<GetLayoutMetricsResponse>

Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

getManifestIcons

fun getManifestIcons(): Single<GetManifestIconsResponse>

getNavigationHistory

fun getNavigationHistory(): Single<GetNavigationHistoryResponse>

Returns navigation history for the current page.

getPermissionsPolicyState

fun getPermissionsPolicyState(input: GetPermissionsPolicyStateRequest): Single<GetPermissionsPolicyStateResponse>

Get Permissions Policy state on given frame.

getResourceContent

fun getResourceContent(input: GetResourceContentRequest): Single<GetResourceContentResponse>

Returns content of the given resource.

getResourceTree

fun getResourceTree(): Single<GetResourceTreeResponse>

Returns present frame / resource tree structure.

handleJavaScriptDialog

fun handleJavaScriptDialog(input: HandleJavaScriptDialogRequest): Single<RequestResponseFrame>

Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

interstitialHidden

fun interstitialHidden(): Flowable<RawEvent>

Fired when interstitial page was hidden

interstitialShown

fun interstitialShown(): Flowable<RawEvent>

Fired when interstitial page was shown

javascriptDialogClosed

fun javascriptDialogClosed(): Flowable<JavascriptDialogClosedEvent>

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.

javascriptDialogOpening

fun javascriptDialogOpening(): Flowable<JavascriptDialogOpeningEvent>

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.

lifecycleEvent

fun lifecycleEvent(): Flowable<LifecycleEventEvent>

Fired for top level page lifecycle events such as navigation, load, paint, etc.

loadEventFired

fun loadEventFired(): Flowable<LoadEventFiredEvent>

Returns observable capturing all Page.loadEventFired events.

name

fun name(): String

Returns domain name.

navigate

fun navigate(input: NavigateRequest): Single<NavigateResponse>

Navigates current page to the given URL.

navigatedWithinDocument

fun navigatedWithinDocument(): Flowable<NavigatedWithinDocumentEvent>

Fired when same-document navigation happens, e.g.

navigateToHistoryEntry

fun navigateToHistoryEntry(input: NavigateToHistoryEntryRequest): Single<RequestResponseFrame>

Navigates current page to the given history entry.

printToPDF

fun printToPDF(input: PrintToPDFRequest): Single<PrintToPDFResponse>

Print page as PDF.

produceCompilationCache

fun produceCompilationCache(input: ProduceCompilationCacheRequest): Single<RequestResponseFrame>

Requests backend to produce compilation cache for the specified scripts.

reload

fun reload(input: ReloadRequest): Single<RequestResponseFrame>

Reloads given page optionally ignoring the cache.

removeScriptToEvaluateOnLoad

fun removeScriptToEvaluateOnLoad(input: RemoveScriptToEvaluateOnLoadRequest): Single<RequestResponseFrame>

Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

removeScriptToEvaluateOnNewDocument

fun removeScriptToEvaluateOnNewDocument(input: RemoveScriptToEvaluateOnNewDocumentRequest): Single<RequestResponseFrame>

Removes given script from the list.

resetNavigationHistory

fun resetNavigationHistory(): Single<RequestResponseFrame>

Resets navigation history for the current page.

screencastFrame

fun screencastFrame(): Flowable<ScreencastFrameEvent>

Compressed image data requested by the startScreencast.

screencastFrameAck

fun screencastFrameAck(input: ScreencastFrameAckRequest): Single<RequestResponseFrame>

Acknowledges that a screencast frame has been received by the frontend.

screencastVisibilityChanged

fun screencastVisibilityChanged(): Flowable<ScreencastVisibilityChangedEvent>

Fired when the page with currently enabled screencast was shown or hidden `.

searchInResource

fun searchInResource(input: SearchInResourceRequest): Single<SearchInResourceResponse>

Searches for given string in resource content.

setAdBlockingEnabled

fun setAdBlockingEnabled(input: SetAdBlockingEnabledRequest): Single<RequestResponseFrame>

Enable Chrome's experimental ad filter on all sites.

setBypassCSP

fun setBypassCSP(input: SetBypassCSPRequest): Single<RequestResponseFrame>

Enable page Content Security Policy by-passing.

setDeviceMetricsOverride

fun setDeviceMetricsOverride(input: SetDeviceMetricsOverrideRequest): Single<RequestResponseFrame>

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

setDeviceOrientationOverride

fun setDeviceOrientationOverride(input: SetDeviceOrientationOverrideRequest): Single<RequestResponseFrame>

Overrides the Device Orientation.

setDocumentContent

fun setDocumentContent(input: SetDocumentContentRequest): Single<RequestResponseFrame>

Sets given markup as the document's HTML.

setDownloadBehavior

fun setDownloadBehavior(input: SetDownloadBehaviorRequest): Single<RequestResponseFrame>

Set the behavior when downloading a file.

setFontFamilies

fun setFontFamilies(input: SetFontFamiliesRequest): Single<RequestResponseFrame>

Set generic font families.

setFontSizes

fun setFontSizes(input: SetFontSizesRequest): Single<RequestResponseFrame>

Set default font sizes.

setGeolocationOverride

fun setGeolocationOverride(input: SetGeolocationOverrideRequest): Single<RequestResponseFrame>

Overrides the Geolocation Position or Error.

setInterceptFileChooserDialog

fun setInterceptFileChooserDialog(input: SetInterceptFileChooserDialogRequest): Single<RequestResponseFrame>

Intercept file chooser requests and transfer control to protocol clients.

setLifecycleEventsEnabled

fun setLifecycleEventsEnabled(input: SetLifecycleEventsEnabledRequest): Single<RequestResponseFrame>

Controls whether page will emit lifecycle events.

setProduceCompilationCache

fun setProduceCompilationCache(input: SetProduceCompilationCacheRequest): Single<RequestResponseFrame>

Forces compilation cache to be generated for every subresource script.

setTouchEmulationEnabled

fun setTouchEmulationEnabled(input: SetTouchEmulationEnabledRequest): Single<RequestResponseFrame>

Toggles mouse event-based touch event emulation.

setWebLifecycleState

fun setWebLifecycleState(input: SetWebLifecycleStateRequest): Single<RequestResponseFrame>

Tries to update the web lifecycle state of the page.

startScreencast

fun startScreencast(input: StartScreencastRequest): Single<RequestResponseFrame>

Starts sending each frame using the screencastFrame event.

stopLoading

fun stopLoading(): Single<RequestResponseFrame>

Force the page stop all navigations and pending resource fetches.

stopScreencast

fun stopScreencast(): Single<RequestResponseFrame>

Stops sending each frame in the screencastFrame.

waitForDebugger

fun waitForDebugger(): Single<RequestResponseFrame>

Pauses page execution.

windowOpen

fun windowOpen(): Flowable<WindowOpenEvent>

Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.

Sources

jvm source